Skip to content

Conversation

@raducotescu
Copy link
Member

Description

API playgrounds rendered with the RedoclyAPIBlock usually load on pages with layout: none, which means that for a short amount of time the page is empty, showing only the top navigation and the footer. When the request to retrieve an OpenAPI definition takes too long it might give the users the impression that the API playground doesn't work at all.

This PR sets the hideLoading configuration option [0] to its default of false, but allows overrides based on component properties.

[0] - https://redocly.com/docs-legacy/api-reference-docs/configuration/functionality

Related Issue

#1638

Motivation and Context

See the "Expected Behavior" from #1638.

How Has This Been Tested?

  • manually by calling the JS code that renders an API definition with the correct settings on an available playground`
  • added an example page in the PR (cannot really be fully tested locally due to not serving the build via https, but the loading spinner is visible)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@raducotescu raducotescu requested a review from timkim as a code owner July 22, 2025 12:42
Copy link
Collaborator

@melissag-ensemble melissag-ensemble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small refactor request on readme

Co-authored-by: melissag-ensemble <120194874+melissag-ensemble@users.noreply.github.com>
@melissag-ensemble melissag-ensemble merged commit bbb402c into adobe:main Jul 30, 2025
2 of 3 checks passed
@melissag-ensemble melissag-ensemble mentioned this pull request Jul 30, 2025
10 tasks
@raducotescu raducotescu deleted the feat/redocly-loading-spinner branch August 5, 2025 07:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants